Cream of the Crop 3/Cream of the Crop 3.iso/comm/aedit100.zip/AEDIT.DOC

Text File | 1993-12-01 | 24KB | 441 lines

                              ╒═════════════════╕
                              │ AEdit v1.00beta │
                              ╘═════════════════╛

Last Product Revision: November 9th, 1993.

───────────────┐
* Introduction │
───────────────┘

AEdit is a simple ASCII text editor.  Though not as powerful as commercial
level word processors, it gets the job done.  AEdit is used to manipulate
standard ASCII files.

Although AEdit was written primarily for those who read BBS mail offline, it
can be used for any other application.

AEdit is freeware, requiring no registration fee.

─────────────┐
* Disclaimer │
─────────────┘

The author of this program shall in no event be held liable to any user for any
damages of any kind, incidental or consequential, arising from the use of or
inability to use this software package.

─────────────────┐
* Included Files │
─────────────────┘

The following files are included in the distribution package (AEDITvvv.ccc,
where vvv is the version number times one hundred, and ccc is the compression
extension):

   AEDIT.DOC    This documentation.
   AEDIT.EXE    The executable program.
AEDITQHE.EXE    The quote header editing utility.
 FILE_ID.DIZ    The identification file.
  README.AED    A quick-start manual on how to setup AEdit under Blue Wave.
   WHATS.NEW    The AEdit history file.

─────────────────────────────┐
* Installation and Execution │
─────────────────────────────┘

AEdit requires no installation.  It accepts one (1) command line parameter from
the DOS command line.  Syntax:

AEDIT.EXE [<filename>]

where <filename> is the name (preceding path optional) of the text file to be
loaded.  If no file is specified then AEdit loads up with no text in memory.

AEdit searches for AEDIT.CFG in the path specified in the DOS environment
variable "aedit".  If no variable has been specified, then it searches in the
current directory.  If no AEDIT.CFG file is found then the user is prompted for
the location of the AEDIT.CFG file, or is asked to create a new one.  If a new
one is created, it is placed in the directory specified with the environment
variable "aedit".  If no environment variable is specified, then AEDIT.CFG is
created in the current directory.

────────┐
* Usage │
────────┘

The Top Of File and End Of File markers cannot be removed, but they will not
be saved with the text.  At the bottom (or top) of the screen, a status line is
constantly displayed.  It shows (from left to right) the path and filename of
the file currently being editted, the current column index, the current row
index, and the status of the Insert/Replace toggle.  This line is also reserved
to display messages/queries to the user; it cannot be editted, but is not part
of the text in the editor.

AEdit accepts standard cursor movements; Left and Right move the cursor along
the current line (up to the margins), Up moves Up one line, Down moves Down
one line.  PgUp will scroll the screen 23 lines upward (up to the Top Of File
marker), leaving the cursor in the same screen position.  Likewise, PgDn will
scroll the screen 23 lines downward.  Home brings the cursor to the leftmost
position of the current line, End will bring the cursor behind the last
character on the line.  Ctrl-Home will bring the cursor to the Top Of File
marker, Ctrl-End will bring the cursor to the End Of File marker.  Ctrl-PgUp
scrolls the screen upwards, Ctrl-PgDn scrolls the screen downwards.  Tab,
Shift-Tab, Backspace and Delete may all be employed in the standard fashion.
Insert will toggle the Insert/Replace toggle.  Ctrl-Left and Ctrl-Right will
go backwards and forwards through the document word by word.

Pressing F1 will show a brief list of commands.

Pressing one of the keys Shift-F1 through Shift-F4 will insert one of four text
files (modifiable in the configuration) starting on the line below the cursor.
Pressing one of the keys Alt-F1 through Alt-F4 will write one of four user
defined macros, starting at the cursor position, bearing the status of the
Insert/Replace toggle in mind.  These two functions are useful for those that
use signatures at the ends of their messages.  Using the macros, short
signatures can be placed.  Using the external files, longer signatures (such
as those containing ANSI codes) can be entered.  Be aware that the imported
text files will have their lines truncated to 79 characters.

Pressing Ctrl-F1 through Ctrl-F4 will toggle one of four line drawing modes.
If the mode is currently in use, it will toggle off, otherwise, it will be
selected.  In line drawing mode, all normal keys are usable, with their normal
functions.  The arrow keys will draw lines in the appropriate direction.
Toggle the line drawing mode off to "lift up" the pen.

Use Shift-F10 to flag a line, Shift-F9 to remove the flag, and F10 to go to
the current flagged line.  When F10 is pressed, and a flag has been placed in
the document, the cursor and screen are placed at the flag, and the flag is
relocated to the position of the cursor prior to pressing F10.  Pressing F10
again will bring the flag, the screen, and the cursor back to their original
positions.  This is useful for marking a certain spot in quoted text, and then
switching back and forth between where you are typing your reply, and the
quoted text.

Shift-F7 and Shift-F8 can be used to call external programs.  The paths, file
names and parameters to these programs can be defined in the configuration.

If a mouse is installed, it may be used to mark text.  Use the first mouse
button to mark blocks.  Use the second mouse button to mark lines.  The mouse
must be toggled On in the Options and Toggles.

───────────────────────┐
* Note on MultiTaskers │
───────────────────────┘

AEdit recognizes most popular multi-taskers (including OS/2, DesqView,
Windows, and many others), and will give up time-slices, to speed computer
operation.

───────────┐
* Commands │
───────────┘

F1     : Displays the command listing.  Press Esc when done viewing.
F3     : Inserts three lines and places the cursor on the second one.  This
         function was designed so that users could place text between text
         (such as reply text between quoted text) in a concise and tidy manner.
F5     : Shells to the Operating System.  Type EXIT to return to AEdit.  The
         environment variable COMSPEC must be set to point to the path of
         COMMAND.COM.
F6     : Deletes all text from the cursor position to the end of the line.

Alt-B  : Selects the beginning or ending of the marked block.  The beginning of
         a block is always the top left-hand corner, and the end of a block is
         always the bottom right hand corner.
Alt-C  : If no block is marked, this function has no effect.  If a linear block
         is marked (one that extends from margin to margin), a duplicate of the
         marked text is inserted between the current line, and the line below
         the cursor.  If the block mark does not span the screen's width, then
         the marked text is instead inserted directly at the cursor position.
         If one of the new, lengthened lines is greater than 79 characters in
         length, you will be asked if you wish to truncate those lines to 79
         characters.  If not, no copy will be made.
Alt-D  : If no block is marked, this function has no effect.  Otherwise, the
         marked text is deleted.
Alt-E  : If no block is marked, this function has no effect.  Otherwise, this
         function is identical to the Alt-D (Delete) function, except the block
         is ERASED, and not DELETED.  In other words, the marked block is
         replaced by a blank space, instead of "taken" from the text.
Alt-I  : Prompts the user for the path and name of a text file, then imports
         it below the cursor position if it exists.
Alt-J  : If no block is marked, all text is affected.  Otherwise, only the
         lines which have a marking upon them are affected.  This function
         justifies text, so that text is evenly distributed from the left
         margin to the right margin.  This does not affect quoted lines.
Alt-L  : Marks an entire line.  If a mark was already established, then the
         marked area is resized.
Alt-M  : If no block is marked, this function has no effect.  Otherwise, this
         function is a combination of the Copy and Delete functions.
Alt-P  : If no block is marked, this function has no effect.  Otherwise, this
         function is identical to the Alt-M (Move) function, except it is a
         combination of the Stamp and Erase functions.
Alt-R  : Reformats text.  To reformat text, at least two _lines_ must be
         marked.  Block marking will not enable this function.  Text is
         formatted, and packed as closely as possible onto the marked lines.
Alt-S  : If no block is marked, this function has no effect.  Otherwise, this
         function is identical to the Alt-C (Copy) function, except the block
         is STAMPED, as opposed to COPIED.  A duplicate of the marked text is
         superimposed (spaces and all) onto the designated area (marked by the
         cursor position), as opposed to "inserted" into the text.
Alt-T  : Allows the user to modify his/her current AEdit configuration.  See
         section on Options and Toggles for more information.
Alt-U  : Unmarks any marked text.
Alt-X  : Exits AEdit, after approval from the user (if the Confirm on Exit
         option is toggled On).  If the current text has not yet been saved,
         then the user will be asked whether or not to save it before
         exitting.  If any options or toggles have been altered, then the user
         is asked whether or not to save the changes.
Alt-Z  : Allows the user to enter a single ASCII character.  ASCII Characters
         may also be entered using the Alt-Keypad approach.

Ctrl-A : This function will ask for a filename, regardless of whether or not
         one has previously been specified.  If the given filename matches that
         of a file that already exists, you will be asked if you wish to
         overwrite the old file with the new text.  The text in the editor will
         be saved under the given filename.  If there is nothing in memory,
         then no text will be saved.
Ctrl-C : If text is marked, then all lines of marked text will be centred,
         using the left and right boundaries of the block mark as the margins.
         If no text is marked, the text of the line designated by the cursor is
         centred.
Ctrl-D : Deletes all text from the cursor to the end of the line, and then
         deletes all text below the current line to the End of File marker.
Ctrl-E : Deletes the current line, and all lines with a row index that is
         greater than the current line, up to the EOF.
Ctrl-L : If the current text has not yet been saved, then you will be asked if
         you wish to save the text currently in memory before loading a new
         file (thereby destroying the text in memory).  When loading a file,
         either a path or an actual file name can be specified.  If a path is
         specified, the directory listing is shown.  If a file is specified,
         and it exists, then the new file is loaded into memory.  Enter a null
         string to abort this function.
Ctrl-S : This function is similar to the Save As (Ctrl-A) function, the
         difference being, if a filename was previously specified, that
         filename is used.  Otherwise, the user is prompted for a filename.
Ctrl-U : Undoes the most recent change to the text.  This function is only
         available if Undo is toggled On in the Configuration.
Ctrl-Y : Deletes the current line.
Ctrl-Z : This is a combination of the Save (Ctrl-S) and Exit (Alt-X) keys.  It
         will save the current file, and then exit AEdit.

──────────────────────┐
* Options and Toggles │
──────────────────────┘

By pressing Alt-T in the editing environment, the user is able to modify the
current AEdit configuration to taste.  Use the cursor keys to move through the
selections.  Use Enter or Space to modify the option.  Use Esc to return to
the editting environment.  If any changes were made to the configuration, the
user has the option of making the changes permanent by selecting the "Save
Changes" option.  The changes take effect for the current editting session,
but if they are saved to disk, they will be in effect the next time AEdit is
loaded.

Word Wrapping: Can either be "On" or "Off".  With word wrapping enabled, when
   the cursor goes beyond the 79th character of a line because of typed text,
   the word is removed from the current line, and either inserted into the next
   line of text, or a new line is formed, and the word is placed there.  AEdit
   is "paragraph sensitive" in this case, and will place it on a new line only
   if you are typing at the end of a paragraph.  (Paragraphs are denoted by
   blank lines).
Colour Configuration: By selecting this option, a new screen appears, showing
   all of AEdit's possible outputs.  Use the up and down cursor keys to
   navigate through the selections.  Use left and right to change the
   foreground colour, use PgUp and PgDn to modify the background colour of the
   current selection.  Use Esc to return to the Options and Toggles listing.
Macros, Text Files: By selecting this option, a new screen appears, showing
   the four Text Files and Macros.  Use the cursor keys to select one of the
   eight options, and use Enter to modify them.
Left Margin: Defines the left margin.  The left margin can be any whole number
   between 1 and the right margin index.
Right Margin: Defines the right margin.  The right margin can be any whole
   number between the left margin index and 79.
Highlight Current Line: With this option toggled On, the current line of the
   editor is highlighted with a colour definable in the Colour Configuration.
Undo: With this option toggled On, users may undo the last change using
   Ctrl-U.  Users with slow hard drives will find this option will slow
   operation of AEdit drastically, and may wish to toggle it off.
Quote Header: Can either be set to None, Manual, Random or Random w/Confirm.
   If set to None, then no quote header will be used for any message.  If set
   to Manual, then the user will select from the Quote Header File which quote
   header to use.  If set to Random, then AEdit will randomly select a quote
   header from the Quote Header File.  If set to Random w/Confirm, then AEdit
   will Randomly select a quote header, but will still allow the user to either
   confirm the selection, or make another selection manually.  In all cases, if
   no Quote Header File is found, then no quote header will be used.  See the
   section in this documentation entitled Quote Headers for further information
   on how to use quote headers.
Kill Trailing Lines: This option allows users to automatically delete all
   taglines, origin lines, kludge lines, and essentially any "garbage" lines
   that follow messages, which are unimportant to the message itself.
Remove "Re:": This option allows users to remove the reply prefix from the
   Subject in their quote headers.  e.g.: With Remove "Re:" option toggled
   off:

                    Quoting Alex Reyes to David Shin about
                    Re: Saturday's Party.

   With Remove "Re:" option toggled on:

                    Quoting Alex Reyes to David Shin about
                    Saturday's Party.

Status Line: Allows users to toggle the position of the status line.  It can
   be either at the top of the screen, or at the bottom.
Tab Size: The size of the Tab can be adjusted to any number between 2 and 40,
   inclusive.
Kludge Lines: Allows up to 10 user definable kludge line headers. If this
   header is found at the beginning of a quoted line when loading up a
   message, that line is not loaded as part of the message text.
External Programs: The path, file names and parameters to the two external
   programs are specified here.  Use @F as to substitute the current document's
   file name.  This function is useful for calling up spell checkers, or
   tagline manipulation utilities, etc.
Keyboard Mapping: Users can modify which keys perform which functions in AEdit
   here, enabling them to change the keyboard map to personal taste, or to
   emulate another popular word processor's keyboard map.
On Status Line: The Status Line can either depict the current document's file
   information, or the date and time, or both (alternating every five seconds).
Confirm on Exit: For those who wish swiftness of exodus, the exit confirmation
   can be toggled completely off.  For those who wish a little security when
   they Exit, but not when they do a quick Save & Exit, the exit confirmation
   can be only when Alt-X is pressed.  For those who wish complete security,
   confirmation can occur when both Ctrl-Z _or_ Alt-X is pressed.
Clock Format: Clock can either show up in 24 hour or 12 hour format.
Swapping on Shell: AEdit can be set to: Not swap (which uses approximately
   300k on the heap), or Swap to EMS, XMS or Disk (which uses approximately 7k
   on the heap), or Swap to either EMS, XMS, or Disk (in that order), whichever
   is available.
Keep Gender Roster: AEdit can keep track of the gender of each person you talk
   to.  This information is kept in a file called AEDIT.ROS.  This file can
   be modified with any text editor (such as AEdit).  Every line contains a
   gender character (either M or F) followed immediately by the person's full
   name, as seen in the message (AEdit does not distinguish between Alias and
   Real Name, despite the fact that they might be the same person).  If you
   wish to conserve disk space, and don't care to ensure your quote headers are
   pronoun-correct, then you can toggle this option off.
Mouse: This toggles the mouse Active or Inactive.  If no mouse is installed
   (or if the device drivers have not been installed) then the mouse will
   remain Inactive.

Save Changes: If changes were made to the configuration, this option will be
   highlighted on the screen.  Use it to permanently save the changes.  All
   changes made to the configuration are in use throughout the current session
   of AEdit, but will not take effect in the next session unless they are saved
   with this option, or with when asked upon exiting AEdit.

────────────────┐
* Quote Headers │
────────────────┘

AEdit is compatible with Blue Wave versions 2.12 and later.  In order for Blue
Wave to properly pass the quote header information to AEdit, Blue Wave's
configuration must be modified so that the quote header string equals the
following CASE SENSITIVE string (without the quotes):

"QH>@N@F@N@T@N@S@N@D"

The string must be entered exactly as it is shown above, or problems may
result.  After that, AEdit will use the quote header(s) designated in the Quote
Header file.

Mail readers other than Blue Wave may possibly be employed, provided a similar
string is passed to AEdit, although use of Blue Wave is recommended.

To create new quote headers, delete old ones, or modify current quote headers,
use the accompanying utility AEDITQHE.EXE found in the AEdit package.  Up to
1000 different quote headers can be defined, each up to 255 characters in
length.  AEdit also supports ANSi and Renegade colour codes in quote headers.
To type in an Escape character (ASCII value 27), use the "open single quote"
(`).  (Not the one located near the enter key, the one on the far top left
corner of the keyboard, just under the Esc key).

Special @ codes can be used in Quote Headers, which can prove useful for
translating information from the quoted message.  Whenever any of these codes
are found in the message, they are replaced with the actual information.
e.g., if @F was found in a quote header, it would be replaced with the full
name of the Author of the quoted message.

Code    Translation
~~~~    ~~~~~~~~~~~
@F      The Author of the quoted message.
@FF     The first name of the Author.
@FL     The last name of the Author.
@T      The Recipient of the quoted message.
@TF     The first name of the Recipient.
@TL     The last name of the Recipient.
@S      The Subject of the quoted message.
@D      The Date the quoted message was written.

@FCHE   The pronoun "he" or "she", depending on the gender of the Author.
@FHIR   The pronoun "his" or "her", depending on the gender of the Author.
@FHEM   The pronoun "him" or "her", depending on the gender of the Author.
@TCHE   The pronoun "he" or "she", depending on the gender of the Recipient.
@THIR   The pronoun "his" or "her", depending on the gender of the Recipient.
@THEM   The pronoun "him" or "her", depending on the gender of the Recipient.

In all codes, capital letters _must_ be used for them to be recognized.

For each of the six pronoun translation codes, small case letters can be used
(e.g. "@fche" instead of "@FCHE") to indicate that the first letter should not
be capitalized (e.g. "she", not "She").  If capital letters are used (e.g.
"@FCHE") then the first letter will be capitalized.  (e.g. "She").

The file AEDIT.QH contains all the quote headers.

────────────┐
* Comments? │
────────────┘

If you have any comments, suggestions, or bug reports, the author can be
reached at the following BBS:

"The BBS That Never Was..." [phone]
14.4k and down, v.32 v.32b v.42 v.42b
TNC    : 20:22/111
BevNet : 50:54/112

Send all E-mail to "The Almost Buddha".

I can also be netmailed at the following FidoNet Address:

Forbidden Knights Systems: 1:259/423

A copy of the latest version can be freq'd from FKS, using the magic filename
"AEDIT".

You can also correspond via the postal service, if you wish, at

Alex Reyes
190 Placentia Blvd.
Scarborough, ON (Canada)
M1S 4H4

───────────────────┐
* Acknowledgements │
───────────────────┘

Thanks are extended to the following persons for their suggestions and/or
invaluable aid in beta-testing this software package (in alphabetical order):

Arcturius - Thorough.  Very thorough.
Blood - Heck, how was _I_ supposed to know your computer would be so slow?
Casanova - Thanks to you, I can now spell proparly.
Darrell Grainger - Let's give a round of applause for the man responsible for
   inspiring the long awaited version 0.86beta.  <insert round of applause>
Eagle1 - May your Ctrl-U keys one day break.
Gym Steele - Just can't live without that mouse support, eh?
Neil LightFoot - You help-screen freak, you.
Pit Meister - Pobody's nerfect.
Rich - So I guess following instructions doesn't always work.
Riim - Ah, nothing like good, solid advice from one programmer to another.
The Rotten Banana Peel - Now that you've been in and out of it, I can safely
   say AEdit is fully Idiot proof.
Zaph - Do you wake up at night wondering if your WordPerfect disks are safe?

I know I might have left some people out, because I've gotten help from so
many.  If you don't see your name up in that list, and you feel it should be
there, don't hesitate to contact me at any of the the above addresses, and
voice your mind!